fix: hide sidebar on landing page and update config docs#47
Conversation
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Remove footer and llms sections that don't exist in schema. Add missing description, icon fields for content and api entries. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR contains two independent changes: a configuration documentation update removing unused YAML sections and adding schema field references, plus a conditional sidebar visibility toggle in the app layout based on landing page detection. ChangesConfiguration Documentation
Landing Page Sidebar Toggle
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/content/docs/configuration.mdx (1)
205-205:⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
versions[].contenttype annotation is stale after addingdescriptionandicon.Line 205 documents the
contentfield as{dir, label}[], but it now acceptsdescriptionandiconas well. Readers configuring version-scoped content won't know these fields are available there too.📝 Proposed fix
-| `content` | `{dir, label}[]` | Content dirs for this version. Entries may rename, reorder, or omit top-level content dirs. | +| `content` | `{dir, label, description?, icon?}[]` | Content dirs for this version. Entries may rename, reorder, or omit top-level content dirs. |🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/content/docs/configuration.mdx` at line 205, Update the docs entry for versions[].content to reflect the new optional fields by changing the type annotation from `{dir, label}[]` to `{dir, label, description?, icon?}[]` (or similar notation showing description and icon are optional) wherever `versions[].content` is documented; ensure the table row text and any explanatory examples mention that `description` and `icon` are supported for each content entry so readers know they can add those fields.
🧹 Nitpick comments (1)
docs/content/docs/configuration.mdx (1)
154-155: ⚡ Quick winThe
contentsection YAML example and theicondescription could be more helpful.Two small gaps:
- The code example just above the table (lines 142–148) still only shows
dirandlabel. Adding a third entry withdescriptionandiconwould let readers copy-paste working config immediately.- Both
iconentries (here and line 315) say "Optional icon identifier" without specifying what format is accepted (e.g., Lucide icon name, a file path, a custom token). Even a brief parenthetical like(e.g., \BookOpen` from Lucide)` would save readers a trip to the source.📝 Suggested example addition
content: - dir: docs label: Docs - dir: dev label: Dev Docs + - dir: guides + label: Guides + description: Step-by-step guides for common workflows. + icon: BookOpen🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/content/docs/configuration.mdx` around lines 154 - 155, Add a third example entry in the "content" section YAML showing `description` and `icon` alongside `dir` and `label` so users can copy a complete example (referencing the `content` example block and the `description`/`icon` fields). Update the `icon` table description text to specify the accepted format (e.g., a Lucide icon name like `BookOpen`, a relative file path, or a custom token) in parentheses so readers know which kinds of values `icon` accepts wherever `icon` is documented.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/content/docs/configuration.mdx`:
- Line 205: Update the docs entry for versions[].content to reflect the new
optional fields by changing the type annotation from `{dir, label}[]` to `{dir,
label, description?, icon?}[]` (or similar notation showing description and icon
are optional) wherever `versions[].content` is documented; ensure the table row
text and any explanatory examples mention that `description` and `icon` are
supported for each content entry so readers know they can add those fields.
---
Nitpick comments:
In `@docs/content/docs/configuration.mdx`:
- Around line 154-155: Add a third example entry in the "content" section YAML
showing `description` and `icon` alongside `dir` and `label` so users can copy a
complete example (referencing the `content` example block and the
`description`/`icon` fields). Update the `icon` table description text to
specify the accepted format (e.g., a Lucide icon name like `BookOpen`, a
relative file path, or a custom token) in parentheses so readers know which
kinds of values `icon` accepts wherever `icon` is documented.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: c83db771-e239-452f-9a32-7fe97286507e
📒 Files selected for processing (2)
docs/content/docs/configuration.mdxpackages/chronicle/src/server/App.tsx
Summary
hideSidebar={isLanding}toDocsLayoutfooterandllmssections, add missingdescription/iconfields for content and api entriesTest plan
🤖 Generated with Claude Code